/*
 *  Copyright (C) 2004  The Concord Consortium, Inc.,
 *  10 Concord Crossing, Concord, MA 01742
 *
 *  Web Site: http://www.concord.org
 *  Email: info@concord.org
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * END LICENSE */

/*
 * Created on Jun 21, 2004
 *
 * TODO To change the template for this generated file go to
 * Window - Preferences - Java - Code Generation - Code and Comments
 */
package org.concord.framework.text;

/**
 * @author scott
 *
 * TODO To change the template for this generated type comment go to
 * Window - Preferences - Java - Code Generation - Code and Comments
 */
public interface UserMessageHandler 
{
	public final static int CLOSED_OPTION = -1;
	
	/**
	 * This shows the message to the user and blocks until they
	 * respond by selecting an option.  It could show a dialog, 
	 * or it might just put an entry in a log file.
	 * 
	 * It returns the option selected by the user, or 
	 * CLOSED_OPTION if the dialog was closed or canceled without
	 * selecting an option.
	 * 
	 * @param message 
	 *  message for the user, usually in the form of a question.
	 * @param title
	 *  short title for the message might be the title of the dialog
	 * @param options
	 *  available options for the user.
	 * @param defaultOption
	 *  the option selected by default.  
	 * @return
	 *  this returns the option select by the user or CLOSED_OPTION
	 *  if they canceled the choice without selecting an option.
	 */
	public int showOptionMessage(String message, String title, String [] options, 
			String defaultOption);

	/**
	 * Show a message to the user.  This will have a single "ok" button
	 * or whatever is appropriate for the platform or presentation.
	 * 
	 * @param message
	 * @param title
	 */
	public void showMessage(String message, String title);
}
